# Russian art ML challenge 2024

![Начало](docs/images/hack_logo.webp)

### 1. Введение
------------
Задачей хакатона являлось создание системы классификации типов произведений
народного искусства Российской Федерации по фотографии.

Целевая метрика - F1 (macro). Лидерборд - 0.68 (бейзлайн - 0.58)

### 2. Структура проекта
------------
    ├── README.md                       <- Верхнеуровневое описание проекта
    ├── requirements.txt                <- Необходимые для установки библиотеки
    ├── src
    │   └── utils.py                    <- Утилиты создания и обучения модели
    │
    ├── data
    │   ├── weights                     <- Веса обученной модели соревнования
    │   ├── private_info                <- Информация о фотографиях (.csv формат)
    │   ├── train                       <- Данные для обучения
    │   └── test                        <- Данные для локальной валидации
    │
    ├── training.py                     <- Скрипт обучения модели
    └── make_submission.py              <- Скрипт генерации посылки в соревновании


### 3. Установка
-----
Для работы использовался Python 3.10.0, необходимые библиотеки есть в `requirements.txt`


### 4. Использование
-----
Убедитесь, что у Вас установлен Docker на локальной машине. В случае отсутствия, перейдите
[сюда](https://docs.docker.com/get-docker/) и проследуйте по инструкции.

После перейдите в командую строку и выполните следующие команды:

<code>docker compose up --build</code>

Далее на [странице документации](http://0.0.0.0:8050/docs), будет доступен конечная точка
`\predict` для классификации картинок, можно загружать и смотреть!